home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xvc / XSGIvcSetScreenInputSyncSource.z / XSGIvcSetScreenInputSyncSource
Text File  |  1998-10-30  |  19KB  |  331 lines

  1.  
  2.  
  3.  
  4.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((3333))))XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((3333))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSGIvcSetScreenInputSyncSource,
  10.           XSGIvcQueryScreenInputSyncSource - Switch sync source
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXX11111111////eeeexxxxtttteeeennnnssssiiiioooonnnnssss////XXXXSSSSGGGGIIIIvvvvcccc....hhhh>>>>
  14.  
  15.           vvvvooooiiiidddd XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  16.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  17.               iiiinnnntttt ssssyyyynnnnccccVVVVoooollllttttaaaaggggeeee,,,,
  18.               iiiinnnntttt ssssyyyynnnnccccSSSSoooouuuurrrrcccceeee))))
  19.  
  20.           vvvvooooiiiidddd XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnEEEExxxxtttteeeerrrrnnnnaaaallllSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  21.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  22.               iiiinnnntttt eeeexxxxtttteeeerrrrnnnnaaaallllSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee))))
  23.  
  24.           SSSSttttaaaattttuuuussss XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyySSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  25.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  26.               iiiinnnntttt ****ssssyyyynnnnccccVVVVoooollllttttaaaaggggeeeeRRRReeeettttuuuurrrrnnnn,,,,
  27.               iiiinnnntttt ****ssssyyyynnnnccccSSSSoooouuuurrrrcccceeeeRRRReeeettttuuuurrrrnnnn,,,,
  28.               BBBBoooooooollll ****lllloooocccckkkkAAAAcccchhhhiiiieeeevvvveeeeddddRRRReeeettttuuuurrrrnnnn))))
  29.  
  30.           SSSSttttaaaattttuuuussss XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyySSSSccccrrrreeeeeeeennnnEEEExxxxtttteeeerrrrnnnnaaaallllSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  31.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  32.               iiiinnnntttt ****eeeexxxxtttteeeerrrrnnnnaaaallllSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeeeRRRReeeettttuuuurrrrnnnn))))
  33.  
  34.           cccchhhhaaaarrrr **** XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyEEEExxxxtttteeeerrrrnnnnaaaallllSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeeeNNNNaaaammmmeeee((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,,
  35.               iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,,
  36.                iiiinnnntttt eeeexxxxtttteeeerrrrnnnnaaaallllSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee))))
  37.  
  38.      PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  39.           _d_i_s_p_l_a_y        Specifies the connection to the X server.
  40.  
  41.           _s_c_r_e_e_n         Specifies the screen of the X server.
  42.  
  43.           _s_y_n_c_V_o_l_t_a_g_e    Specifies the voltage.  Should be specified
  44.                          as one of XXXXSSSSGGGGIIIIVVVVCCCC____SSSSYYYYNNNNCCCC____VVVVOOOOLLLLTTTTAAAAGGGGEEEE____VVVVIIIIDDDDEEEEOOOO (for
  45.                          nominal video voltage level) or
  46.                          XXXXSSSSGGGGIIIIVVVVCCCC____SSSSYYYYNNNNCCCC____VVVVOOOOLLLLTTTTAAAAGGGGEEEE____TTTTTTTTLLLL (for TTL-level sync).
  47.                          Not all servers have the capability to accept
  48.                          both voltage levels; check documentation for
  49.                          the specific hardware you are using.
  50.  
  51.           _e_x_t_e_r_n_a_l_S_y_n_c_S_o_u_r_c_e
  52.                          Specifies the external sync source.  The
  53.                          values range [0..External Source Count).
  54.  
  55.           _s_y_n_c_S_o_u_r_c_e     Use XSGIVC_SYNC_SOURCE_EXTERNAL to specify
  56.                          the external sync source,
  57.                          XSGIVC_SYNC_SOURCE_INTERNAL to specify the
  58.                          internal sync source.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((3333))))XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((3333))))
  71.  
  72.  
  73.  
  74.           _s_y_n_c_V_o_l_t_a_g_e_R_e_t_u_r_n
  75.                          Returns the current sync voltage.
  76.  
  77.           _s_y_n_c_S_o_u_r_c_e_R_e_t_u_r_n
  78.                          Returns the current sync source.
  79.  
  80.           _l_o_c_k_A_c_h_i_e_v_e_d_R_e_t_u_r_n
  81.                          Returns the state of lock (TRUE if lock
  82.                          achieved, FALSE if lock not achieved).  See
  83.                          terminology, below, for explanation.
  84.  
  85.           _e_x_t_e_r_n_a_l_S_y_n_c_S_o_u_r_c_e_R_e_t_u_r_n
  86.                          Returns the current external sync source.
  87.  
  88.  
  89.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  90.           These functions control the source of input sync to the
  91.           graphics subsystem.  The input sync is used as a reference
  92.           to which the server can lock.  The information returned from
  93.           the function XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyVVVViiiiddddeeeeooooSSSSccccrrrreeeeeeeennnnIIIInnnnffffoooo can help you
  94.           determine whether the server currently has the capability to
  95.           lock to an external source.
  96.  
  97.  
  98.         TTTTeeeerrrrmmmmiiiinnnnoooollllooooggggyyyy aaaannnndddd OOOOppppeeeerrrraaaattttiiiioooonnnn
  99.           The concept of _l_o_c_k_i_n_g refers to the ability of a video
  100.           system to evaluate the synchronization portion of a video
  101.           signal of an external source and produce a signal which is
  102.           at the same rate as that external signal.  Locking the
  103.           server to an external source is needed in environments where
  104.           the server's video output must be synchronized with other
  105.           video or film sources in order to be mixed externally.
  106.  
  107.           The term _g_e_n_l_o_c_k describes a particular type of lock:  one
  108.           in which both horizontal and vertical synchronization
  109.           signals are locked.  It is often used as a general term for
  110.           locking in environments where all video devices generate and
  111.           use the same video formats; in this circumstance, the term
  112.           genlock is correct.  See the discussion of LLLLoooocccckkkk QQQQuuuuaaaalllliiiittttyyyy
  113.           below.
  114.  
  115.           A server may operate in a stand-alone environment in the
  116.           absence of a stable external locking signal; by using this
  117.           _i_n_t_e_r_n_a_l _l_o_c_k, the server locks to a clock generated within
  118.           the server hardware.  With external lock, the server locks
  119.           to a signal you supply externally, either on an external
  120.           sync connector or other means, such as internally-connected
  121.           special video hardware.
  122.  
  123.           When you instruct the server to use external sync (external
  124.           lock), the server examines the synchronization signal
  125.           provided on the external input sync port.  If the server
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((3333))))XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((3333))))
  137.  
  138.  
  139.  
  140.           hardware recognizes the signal's pattern, the server locks
  141.           the rate to that of the signal. After the server's rates
  142.           have been set successfully, the server is said to be locked
  143.           to the external signal.
  144.  
  145.           When you specify the server should use internal lock, the
  146.           server will disregard any external signal.  Because internal
  147.           lock allows the server to produce video at a rate
  148.           independent of any external source, it is often described as
  149.           being "not locked" or has disabled lock.
  150.  
  151.  
  152.         UUUUssssaaaaggggeeee
  153.           If the server is used in a stand-alone environment, it is
  154.           not necessary to set the sync source to anything but the
  155.           internal source; the server will produce its output locked
  156.           to its own reference.  However, in applications where the
  157.           graphics output must be synchronized to an external source,
  158.           you can direct the server to use the external source as lock
  159.           reference.
  160.  
  161.  
  162.         LLLLoooocccckkkk QQQQuuuuaaaalllliiiittttyyyy
  163.           Different servers have different capabilities when locking
  164.           to an external source, and the quality of lock may vary
  165.           depending on the input source and the generated output
  166.           format.
  167.  
  168.           Under some circumstances, the server may be able to lock to
  169.           both horizontal and vertical rates of the external signal:
  170.           the most stable lock, commonly known as _g_e_n_l_o_c_k.  Some
  171.           circumstances may permit the server to lock to only the
  172.           vertical rate of the incoming signal.  In other cases, the
  173.           server may be able to provide a reference at multiple
  174.           instances within a frame, a quality between those two
  175.           extremes.  Finally, some combination of input and output
  176.           format or some servers may not permit any lock. Refer to
  177.           your server's documentation to determine the qualities of
  178.           lock available.
  179.  
  180.  
  181.         EEEExxxxtttteeeerrrrnnnnaaaallll SSSSyyyynnnncccc SSSSoooouuuurrrrcccceeeessss
  182.           Some servers have more than one external sync source. For
  183.           example, a server may have more than one connector on which
  184.           sync can be provided; or, a server's hardware might have an
  185.           option board which can also provide a sync source.  Because
  186.           of the nature of locking (see TTTTeeeerrrrmmmmiiiinnnnoooollllooooggggyyyy aaaannnndddd OOOOppppeeeerrrraaaattttiiiioooonnnn
  187.           above), only one sync source may be selected at a time.
  188.  
  189.  
  190.  
  191.         FFFFuuuunnnnccccttttiiiioooonnnnssss
  192.  
  193.  
  194.  
  195.      PPPPaaaaggggeeee 3333                                          ((((pppprrrriiiinnnntttteeeedddd 4444////33330000////99998888))))
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((3333))))XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((3333))))
  203.  
  204.  
  205.  
  206.           XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee sets the server's Screen sync
  207.           source to the internal or external source.
  208.  
  209.           XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyySSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee returns the current
  210.           settings of the sync source for the server's Screen.  This
  211.           function also returns the current state of the lock.
  212.  
  213.           For servers with more than one external sync source,
  214.           XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnEEEExxxxtttteeeerrrrnnnnaaaallllSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee selects which external
  215.           source is to be used for locking.  The structure returned by
  216.           the function XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyVVVViiiiddddeeeeooooSSSSccccrrrreeeeeeeennnnIIIInnnnffffoooo has a member field
  217.           containing the number of external sync sources.  The
  218.           function XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyySSSSccccrrrreeeeeeeennnnEEEExxxxtttteeeerrrrnnnnaaaallllSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee returns the
  219.           currently selected external sync source. Selecting an
  220.           external sync source with XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnEEEExxxxtttteeeerrrrnnnnaaaallllSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee
  221.           does not switch from the internal to the external sync
  222.           source; it is still necessary to use the function
  223.           XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee to switch from internal to
  224.           external sync source.
  225.  
  226.           For convenience in presenting information to a user,
  227.           XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyEEEExxxxtttteeeerrrrnnnnaaaallllSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeeeNNNNaaaammmmeeee returns the textual name
  228.           associated with the sync source.  You must free the returned
  229.           string with XFree.
  230.  
  231.  
  232.      EEEEVVVVEEEENNNNTTTTSSSS
  233.           The sync source state change event reports dynamic input
  234.           sync source state changes.  The server generates a
  235.           SSSSccccrrrreeeeeeeennnnLLLLoooocccckkkkSSSSttttaaaattttuuuussssCCCChhhhaaaannnnggggeeeeddddNNNNoooottttiiiiffffyyyy  event when the server
  236.           achieves or loses lock.  This allows you to determine when a
  237.           server achieves lock. The server may not be able to report
  238.           intervening instances of rapidly changing lock state and
  239.           therefore may report two consecutive instances of the same
  240.           state; client programs must check the value of the status
  241.           variable reported in the event to determine the state of the
  242.           lock.
  243.  
  244.           When this control is altered, the server generates a
  245.           SSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeeeNNNNoooottttiiiiffffyyyy event.
  246.  
  247.  
  248.  
  249.      RRRREEEETTTTUUUURRRRNNNNEEEEDDDD VVVVAAAALLLLUUUUEEEE
  250.           XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyySSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee returns TRUE if successful,
  251.           FALSE upon failure.
  252.  
  253.           Parameter errors are reported via BadValue or BadMatch.
  254.  
  255.  
  256.  
  257.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  258.  
  259.  
  260.  
  261.      PPPPaaaaggggeeee 4444                                          ((((pppprrrriiiinnnntttteeeedddd 4444////33330000////99998888))))
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((3333))))XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttSSSSccccrrrreeeeeeeennnnIIIInnnnppppuuuuttttSSSSyyyynnnnccccSSSSoooouuuurrrrcccceeee((((3333))))
  269.  
  270.  
  271.  
  272.           XSGIvc, XSGIvcQueryChannelInfo,
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 4/30/98)
  328.  
  329.  
  330.  
  331.